home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / help24.arc / HELP.DOC < prev    next >
Encoding:
Text File  |  1988-06-11  |  7.7 KB  |  160 lines
  1.                                  Help 2.4.1
  2.                             Copyright 1986, 1988
  3.                              by Unique Software
  4.                            Post Office Box 26613
  5.                           Fort Worth, Texas 76126
  6.  [MCI-Mail:252-8689  American People Link:UNIQUESOFT CompuServe:70130,330]
  7.      
  8.                               Help? Help with what?
  9.      
  10.          You've probably seen many help utilities. Some files over 40K will
  11.      give  you a complete online DOS help facility.  But how many  valuable
  12.      bytes  of  your  disk space is wasted for HELP for commands  that  you
  13.      already  know.  Do you really want to sacrifice 10K of your disk space
  14.      for  instructions on how to use commands like DEL,  COPY,  FORMAT  and
  15.      many others that you know by heart? Some shareware programs give you a
  16.      cryptic  quick reference to their use.  Others give no online help  at
  17.      all.  What if  you could custom tailor a HELP utility to your changing
  18.      needs?   What  if you could delete the HELP references  once  you  are
  19.      comfortable with a program or command? You can do all this with HELP!
  20.      
  21.                                    HELP format
  22.      
  23.          HELP keyword - give help for specific keyword
  24.          HELP - list all keywords available
  25.      
  26.                                 Before you start
  27.      
  28.          Always keep your original copy of HELP.COM in a safe place!  After
  29.      you  develop  your  HELP text file it will be appended to  a  COPY  of
  30.      HELP.COM.
  31.      
  32.                               HELP text file format
  33.      
  34.          You can build your personal help file with any word processor that
  35.      will output standard ASCII text files. Essentially what you see on
  36.      your word processor's screen is what HELP will output. The few
  37.      formatting commands are as follows:
  38.      
  39.                                     Keywords
  40.      
  41.          These are the words by which HELP will reference the text. They
  42.      appear at the start of each section of help text, but are NOT part of
  43.      the text itself. They must be followed by a <CR><LF>!
  44.      
  45.                               "$" - the dollar sign
  46.          This has to end EACH individual help item. NEVER use a "$" in the
  47.      midst of any help text.
  48.          NOTE: There cannot be a <CR>/<CR><LF> between the end of a help
  49.      text section "$" and the following keyword for the next help text
  50.      section. See Anomalies.
  51.      
  52.                             "&&" - double ampersands
  53.          This has to terminate the ENTIRE HELP file. It's HELP's way of
  54.      knowing where to stop looking for your help text.
  55.          NOTE: since the "$" must appear at the end of each single help
  56.      text, the ending sequence of the entire file would always be "$&&".
  57.      
  58.                             "`" - reverse apostrophe
  59.          This is used to cross-reference keywords. The format for use is:
  60.          cross_reference_keyword`previously_appearing_keyword$
  61.          For example,  to cross-reference CHDIR to CD you would insert  the
  62.      following into your help text file:
  63.          CHDIR`CD$
  64.          NOTE:   the second word in the reference SHOULD appear before  the
  65.      cross  reference.   Usually the logical place would be to  insert  the
  66.      cross reference directly after the original reference.
  67.      
  68.                                     Anomalies
  69.      
  70.          As you begin to build your text file you might be tempted to make
  71.      it look like this:
  72.      
  73.          ASSIGN drive1: drive2:
  74.          makes all references to drive1: goto drive2:$
  75.          ASN`ASSIGN$
  76.          BACKUP drive1: drive2:
  77.          backs up all files from drive1: to drive 2:$
  78.          [etc]
  79.          ending text$
  80.          &&
  81.      
  82.          While  this may look correct it is highly incorrect.  First,  HELP
  83.      would  determine  the  first keyword to  be  "ASSIGN drive1: drive2:".
  84.      Second,  help would determine  the second keyword to be "<CR><LF>ASN".
  85.      Help would note that it is a cross-reference, but then you would never
  86.      be able to type in "<CR><LF>ASN" and also HELP would never find ASSIGN
  87.      (explained previously).  Also help may misinterpret the ending  marker
  88.      "&&"  since it is preceded by a <CR><LF> instead of a "$".  Let's look
  89.      at this sequence corrected in HELP's format:
  90.      
  91.          ASSIGN
  92.          ASSIGN drive1: drive2:
  93.          makes all references to drive1: goto drive2:$ASN`ASSIGN$BACKUP
  94.          BACKUP drive1: drive2:
  95.          backs up all files from drive1: to drive 2:$(next keyword)
  96.          ...ending text$&&
  97.      
  98.          We think the corrected example explains the format. A generalized
  99.      format for HELP is:
  100.      
  101.          KEYWORD
  102.          help text
  103.          help text
  104.          help text
  105.          ...
  106.          help text$CROSS_REFERENCE`KEYWORD$KEYWORD
  107.          help text
  108.          help text
  109.          ...
  110.          help text$&&
  111.      
  112.                                    HELP errors
  113.      
  114.          HELP has one error message "No Help Found". Usually the cause is
  115.      that you mistyped the keyword. Either at the DOS prompt or in the HELP
  116.      text file itself. If you are continually having this problem or type
  117.      in "HELP FILTERS" when the actual keyword is "FILTER". Try adding a
  118.      cross reference for your typo's. Maybe even one admonishing you for
  119.      your bad spelling or fumble fingers.
  120.      
  121.                                 Making HELP work
  122.      
  123.          First of all, keep your original of HELP.COM or HELP.ARC in a safe
  124.      place. DO NOT use this procedure on your original copy of HELP.COM!
  125.          Once you have finished your first HELP text file the procedure is
  126.      simple for making HELP work. Just type in:
  127.          COPY HELP.COM+help_text_file_name
  128.          DOS should respond with "1 file(s) copied".
  129.          A sample HELP text file is included with HELP.COM and HELP.DOC
  130.      giving details of ANSI escape sequences. To make a working HELP.COM
  131.      file from this you would type:
  132.          COPY HELP.COM+HELP.TXT
  133.          This procedure only affects the HELP.COM file. Your HELP text file
  134.      is unaffected and SHOULD also be kept in a safe place for when you
  135.      want to add or delete from it.
  136.          NOTE: When using the COPY + command always have a fresh copy of
  137.      HELP.COM from the ORIGINAL HELP.ARC file. You CAN NOT reCOPY+ another
  138.      HELP text file onto a working HELP.COM file.
  139.      
  140.                           Shareware and Unique Software
  141.      
  142.          The  files contained herein are distributed on two concepts.   The
  143.      first concept,  the Shareware concept,  provides that this software is
  144.      to  be freely distributed in an un-modified state.  You are encouraged
  145.      to copy,  give,  upload any of our un-modified software to any person,
  146.      bulletin board or entity.  The second concept,  we call "FairWare", is
  147.      that   Unique   Software   should  provide  valuable,  useful,  and/or
  148.      entertaining software, programming techniques, and/or information. 
  149.          The first concept works only if the second concept is fulfilled by
  150.      us.   We  do not require or set a "donation."  We  do  not  distribute
  151.      software and expect "charity" in return. Instead, we only want payment
  152.      from those who feel that our software, programming techniques,  and/or
  153.      information is valuable,  useful, and/or entertaining. The amount? How
  154.      valuable, useful, and/or entertaining is it to you?
  155.          We only ask two things from our users. First, that you foward your
  156.      name and address with any payment you might make. (This will enable us
  157.      to  inform  you  of  any  upgrade or  bugs  found.)   Along  with  any
  158.      suggestions or comments on the program. Second, Enjoy!
  159.  
  160.